Skip to main content

Rename-IMAPIKey

SYNOPSIS​

Renames an Immich API key

SYNTAX​

Rename-IMAPIKey [[-Session] <ImmichSession>] [-Id] <String> [-Name] <String>
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Updates the name of an existing API key. This helps maintain organized and descriptive names for API keys as their usage evolves.

EXAMPLES​

EXAMPLE 1​

Rename-IMAPIKey -Id 'bde7ceba-f301-4e9e-87a2-163937a2a3db' -Name 'Production Backup Script'

Renames the specified API key to 'Production Backup Script'.

EXAMPLE 2​

Get-IMAPIKey | Where-Object {$_.name -eq 'temp'} | Rename-IMAPIKey -Name 'Mobile App Access'

Finds an API key named 'temp' and renames it to 'Mobile App Access'.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The UUID of the API key to rename. Accepts pipeline input.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Name​

The new name for the API key. Should be descriptive to help identify the key's purpose.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github